[skip changelog] Correct format of upload_port identification properties in snippet
#2655
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rties in snippet The platform developer can associate port properties with a board definition in order to cause Arduino CLI to identify ports having those properties as that board. The list format is supported for these platform properties in order to allow multiple alternative port property sets to be associated. The platform property must have the format `upload_port.n.<property ID>` (where "n" is the array index of the port property set). Although the platform property format is correctly documented in the Arduino Platform Specification, an incorrect format `upload_port.<property ID>.n` was previously used in the boards.txt snippet illustrating the use of the platform properties.
per1234
added
topic: documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Docs fix
What is the current behavior?
The platform developer can associate port properties with a board definition in order to cause Arduino CLI to identify ports having those properties as that board.
The list format is supported for these platform properties in order to allow multiple alternative sets of port properties to be associated with a board definition. The platform property must have the format
upload_port.n.<property ID>(wherenis the array index of the port properties set).Although the platform property format is correctly documented in the Arduino Platform Specification, an incorrect format
upload_port.<property ID>.nwas previously used in theboards.txtsnippet illustrating the use of the platform properties.What is the new behavior?
The snippet uses the correct property format.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.